CIMPLICITY Configuration REST API Web Service
CIMPLICITY Configuration REST API Web Service / All Operations Resource Group / /projects/{projectId}/SQLConnections (Get)
Get/projects/{projectId}/SQLConnections
Description
Gets an array of SQL connections objects that satisfy the query criteria
Parameters
NameDescriptionData Type
the id of the projectstring
filters the list of connections based on the table_idstring
provides a wild card string to filter sql connections by their connection type.(undefined)
200 Response

The response body is of type SQLGetResponse.

The collection of sql connections that satisfy the query.

Overview

SQLGetResponse
The results of the points get query
SQLDefaultConnections : Array[CimSQLConnection]
ConnectionType : CimSQLConnectionType
ODBCDataSource : string
UserID : string
Passsword : string
ReconnectWaitPeriod : integer
ReconnectWaitUnit : CimTimeUnitEnum
EnableStoreAndForward : boolean
MaxNumberOfStoredRecord : number
SQLTableConnections : Array[CimSQLTableConnection]
Table_id : string
SQLConnection : CimSQLConnection
ConnectionType : CimSQLConnectionType
ODBCDataSource : string
UserID : string
Passsword : string
ReconnectWaitPeriod : integer
ReconnectWaitUnit : CimTimeUnitEnum
EnableStoreAndForward : boolean
MaxNumberOfStoredRecord : number
Fault Responses
FaultDescription
This fault returns a response body of type ProblemDetails.
Error if objects not found
This fault returns a response body of type .
General error
See Also